home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / dmedia / dmbufalloc.z / dmbufalloc
Encoding:
Text File  |  1998-10-20  |  6.5 KB  |  67 lines
  1.  
  2.  
  3.  
  4. ddddmmmmBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))                                                    ddddmmmmBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee,,,, ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeeeSSSSiiiizzzzeeee,,,, ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAttttttttaaaacccchhhh,,,, ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee,,,,
  10.      ddddmmmmBBBBuuuuffffffffeeeerrrrGGGGeeeettttAAAAllllllllooooccccSSSSiiiizzzzeeee - allocate and free a DMbuffer
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ddddmmmm____bbbbuuuuffffffffeeeerrrr....hhhh>>>>
  14.  
  15.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee((((DDDDMMMMbbbbuuuuffffffffeeeerrrrppppoooooooollll ppppoooooooollll,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr ****bbbbuuuuffffffffeeeerrrr))));;;;
  16.  
  17.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeeeSSSSiiiizzzzeeee((((DDDDMMMMbbbbuuuuffffffffeeeerrrrppppoooooooollll ppppoooooooollll,,,, iiiinnnntttt ssssiiiizzzzeeee,,,, DDDDMMMMbbbbuuuuffffffffeeeerrrr ****bbbbuuuuffffffffeeeerrrr))));;;;
  18.  
  19.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAttttttttaaaacccchhhh(((( DDDDMMMMbbbbuuuuffffffffeeeerrrr ****bbbbuuuuffffffffeeeerrrr))));;;;
  20.  
  21.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee((((DDDDMMMMbbbbuuuuffffffffeeeerrrr bbbbuuuuffffffffeeeerrrr))));;;;
  22.  
  23.      iiiinnnntttt ddddmmmmBBBBuuuuffffffffeeeerrrrGGGGeeeettttAAAAllllllllooooccccSSSSiiiizzzzeeee((((DDDDMMMMbbbbuuuuffffffffeeeerrrrppppoooooooollll ppppoooooooollll))));;;;
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee reserves a DMbuffer in the specified DMbufferpool.  The
  27.      buffer handle is returned to the address specified with bbbbuuuuffffffffeeeerrrr.... The
  28.      availability of buffers in the pool is determined with select(2) (See
  29.      ddddmmmmBBBBuuuuffffffffeeeerrrrGGGGeeeettttPPPPoooooooollllFFFFDDDD((((3333ddddmmmm)))) ).  If no buffers are available this call
  30.      immediately returns with DM_FAILURE.  The buffer remains reserved until
  31.      its handle is passed to ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee((((3333ddddmmmm))))....
  32.  
  33.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeeeSSSSiiiizzzzeeee is similar to dmBufferAllocate except that a buffer
  34.      size may be specified which is different from the default size set when
  35.      the DMbufferpool was created.  This call can only be used on
  36.      DMbufferpools created with the DDDDMMMM____PPPPOOOOOOOOLLLL____VVVVAAAARRRRIIIIAAAABBBBLLLLEEEE parameter set although
  37.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee can be used on any pool regardless of this parameter
  38.      (see ddddmmmmBBBBuuuuffffffffeeeerrrrCCCCrrrreeeeaaaatttteeeePPPPoooooooollll((((3333ddddmmmm)))) ).
  39.  
  40.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeeeSSSSiiiizzzzeeee returns DM_FAILURE if called on a DMbufferpool that
  41.      was created without the DDDDMMMM____PPPPOOOOOOOOLLLL____VVVVAAAARRRRIIIIAAAABBBBLLLLEEEE parameter set, if no buffers are
  42.      available, or if not enough space remains in the pool to satisfy the size
  43.      request.
  44.  
  45.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAttttttttaaaacccchhhh attaches a user to a buffer that has already been
  46.      allocated using ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee((((3333ddddmmmm)))) A user attached to a buffer must
  47.      free the buffer ( ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee((((3333ddddmmmm)))) ) when it is no longer needed.
  48.  
  49.      ddddmmmmBBBBuuuuffffffffeeeerrrrFFFFrrrreeeeeeee indicates the buffer is no longer being used by the caller
  50.      and will eventually be freed.  Operations on bbbbuuuuffffffffeeeerrrr after this call are
  51.      invalid and not defined.
  52.  
  53.      ddddmmmmBBBBuuuuffffffffeeeerrrrGGGGeeeettttAAAAllllllllooooccccSSSSiiiizzzzeeee returns the size of the buffer allocated when a
  54.      ddddmmmmBBBBuuuuffffffffeeeerrrrAAAAllllllllooooccccaaaatttteeee is called on ppppoooooooollll....
  55.  
  56. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  57.      dmBufferCreatePool(3dm), dmBufferGetPoolState(3dm), dmICSend(3dm),
  58.      dmGetError(3dm), vlDMBufferSend(3dm).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.